RESTful API 设计规范与实现 · 课程目录

01 RESTful API 概述

什么是REST
六大约束
优势与适用场景

02 HTTP 协议基础

请求方法 (GET/POST/PUT/DELETE/PATCH)
状态码 (2xx/3xx/4xx/5xx)
头部与缓存控制

03 URI 设计规范

资源命名规则
层级结构设计
版本控制策略
查询参数使用

04 请求与响应设计

请求体格式 (JSON/XML)
响应体结构设计
分页与排序设计
错误响应格式

05 资源表示与序列化

资源状态与表示
JSON序列化最佳实践
HATEOAS超媒体链接
内容协商

06 认证与授权

基本认证 (Basic Auth)
Token认证 (JWT)
OAuth2.0流程
API Key管理

07 API 版本控制

URI版本控制
请求头版本控制
媒体类型版本控制
版本兼容性策略

08 错误处理与异常

HTTP状态码选择
错误响应体设计
全局异常处理
错误码与错误消息

09 数据校验与验证

请求参数校验
JSON Schema验证
业务规则验证
校验错误反馈

10 分页、过滤与排序

分页策略 (Offset/Page, Cursor)
过滤参数设计
排序参数设计
性能优化

11 HATEOAS 与超媒体

HATEOAS概念
链接关系定义
动态API导航
客户端发现机制

12 API 文档与规范

OpenAPI/Swagger规范
API文档自动生成
API变更日志
文档版本管理

13 API 测试策略

单元测试
集成测试
契约测试
性能测试与负载测试

14 API 安全最佳实践

HTTPS强制
CORS配置
速率限制 (Rate Limiting)
防SQL注入与XSS

15 缓存策略

HTTP缓存头 (Cache-Control/ETag)
服务端缓存 (Redis)
客户端缓存
缓存失效策略

16 异步API设计

异步请求模式
回调URL设计
Webhook实现
消息队列集成

17 GraphQL 与 REST 对比

GraphQL核心概念
REST vs GraphQL适用场景
混合架构设计
迁移策略

18 微服务中的API网关

API网关作用
路由与负载均衡
限流与熔断
日志与监控

19 API 监控与日志

请求日志记录
性能指标监控 (Prometheus)
告警策略
分布式追踪 (Jaeger)

20 API 版本迁移与废弃

向后兼容策略
废弃通知机制
版本迁移计划
旧版本下线流程

21 RESTful API 设计模式

资源嵌套模式
批量操作模式
部分更新模式 (PATCH)
查询语言模式

22 国际化与本地化

多语言支持
时区处理
货币与单位格式化
错误消息国际化

23 文件上传与下载

文件上传设计
文件下载与断点续传
文件类型验证
存储策略 (本地/S3/CDN)

24 实时API设计

WebSocket集成
Server-Sent Events
长轮询
实时通知架构

25 API 契约与SDK生成

OpenAPI契约驱动开发
客户端SDK自动生成
服务端Stub生成
契约测试

26 RESTful API 性能优化

数据库查询优化
N+1问题解决
响应压缩
连接池管理

27 API 治理与标准化

API命名规范
版本规范
错误码规范
团队协作流程

28 RESTful API 与前端协作

前后端分离模式
Mock API设计
API变更通知
联调流程

29 RESTful API 与移动端适配

弱网优化
流量节省
离线缓存
移动端认证

30 综合实战：从零构建RESTful API

需求分析
架构设计
编码实现
测试部署
文档输出